
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>ambient.Profile.append &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="ambient.Profile.buoyancy_frequency" href="ambient.Profile.buoyancy_frequency.html" />
    <link rel="prev" title="ambient.Profile" href="ambient.Profile.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="ambient-profile-append">
<h1>ambient.Profile.append<a class="headerlink" href="#ambient-profile-append" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="ambient.Profile.append">
<code class="sig-prename descclassname">Profile.</code><code class="sig-name descname">append</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">data</em>, <em class="sig-param">var_symbols</em>, <em class="sig-param">var_units</em>, <em class="sig-param">comments=None</em>, <em class="sig-param">z_col=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ambient.html#Profile.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ambient.Profile.append" title="Permalink to this definition">¶</a></dt>
<dd><p>Add data to the netCDF dataset and update the object attributes</p>
<p>This method provides an interface to the <cite>fill_nc_db</cite> function
and performs the necessary updates to all affected object attributes.
This is the only way that data should be added to a netCDF file 
contained in a Profile class object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>data</strong><span class="classifier">ndarray</span></dt><dd><p>Table of data to add to the netCDF database.  If it contains more
than one variable, the data are assumed to be arranged in columns.</p>
</dd>
<dt><strong>var_symbols</strong><span class="classifier">string list</span></dt><dd><p>List of string symbol names (e.g., T, S, P, etc.) in the same 
order as the columns in the data array.  For chemical properties,
use the key names in the chemical_properties.py database.</p>
</dd>
<dt><strong>var_units</strong><span class="classifier">string list</span></dt><dd><p>List of units associated with each variable in the <cite>var_symbols</cite> 
list.</p>
</dd>
<dt><strong>comments</strong><span class="classifier">string list</span></dt><dd><p>List of comments associated with each variable in the 
<cite>var_symbols</cite> list.  As a minimum, this list should include the 
indications ‘measured’ or ‘derived’ or some similar indication of 
source of the data.</p>
</dd>
<dt><strong>z_col</strong><span class="classifier">integer, default is 0</span></dt><dd><p>Column number of the column containing the depth data.  The first 
column is numbered zero.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Once a Profile object is created, data should only be added to the 
object’s netCDF dataset through this append method.  While direct 
calls to <cite>ambient.fill_nc_db</cite> will not create errors, the resulting
netCDF dataset will no longer be compatible with the Profile object
attributes.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/ambient.html">Overview of Ambient Module</a><ul>
  <li><a href="ambient.Profile.html">ambient.Profile</a><ul>
      <li>Previous: <a href="ambient.Profile.html" title="previous chapter">ambient.Profile</a></li>
      <li>Next: <a href="ambient.Profile.buoyancy_frequency.html" title="next chapter">ambient.Profile.buoyancy_frequency</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/ambient/ambient.Profile.append.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>